<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>lacewing.packetloaders.directmessage</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lacewing-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://mathias.aquadasoft.com">Python Lacewing Library</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="lacewing-module.html">Package&nbsp;lacewing</a> ::
        <a href="lacewing.packetloaders-module.html">Package&nbsp;packetloaders</a> ::
        Module&nbsp;directmessage
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="lacewing.packetloaders.directmessage-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="lacewing.packetloaders.directmessage-module.html">Module lacewing.packetloaders.directmessage</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-docstring">Direct messages from client to server and vice versa</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">struct</tt> <tt class="py-keyword">import</tt> <tt class="py-name">unpack_from</tt><tt class="py-op">,</tt> <tt class="py-name">pack</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package lacewing=lacewing-module.html"><a title="lacewing" class="py-name" href="#" onclick="return doclink('link-0', 'lacewing', 'link-0');">lacewing</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module lacewing.baseloader=lacewing.baseloader-module.html"><a title="lacewing.baseloader" class="py-name" href="#" onclick="return doclink('link-1', 'baseloader', 'link-1');">baseloader</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">_BaseLoader</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-2" class="py-name"><a title="lacewing" class="py-name" href="#" onclick="return doclink('link-2', 'lacewing', 'link-0');">lacewing</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Package lacewing.moo.packetloaders=lacewing.moo.packetloaders-module.html,Package lacewing.packetloaders=lacewing.packetloaders-module.html"><a title="lacewing.moo.packetloaders
lacewing.packetloaders" class="py-name" href="#" onclick="return doclink('link-3', 'packetloaders', 'link-3');">packetloaders</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Module lacewing.moo.packetloaders.common=lacewing.moo.packetloaders.common-module.html,Module lacewing.packetloaders.common=lacewing.packetloaders.common-module.html"><a title="lacewing.moo.packetloaders.common
lacewing.packetloaders.common" class="py-name" href="#" onclick="return doclink('link-4', 'common', 'link-4');">common</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">_DataTypeMixin</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"> </tt>
<a name="_DirectCommon"></a><div id="_DirectCommon-def"><a name="L10"></a><tt class="py-lineno">10</tt> <a class="py-toggle" href="#" id="_DirectCommon-toggle" onclick="return toggle('_DirectCommon');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lacewing.packetloaders.directmessage._DirectCommon-class.html">_DirectCommon</a><tt class="py-op">(</tt><tt class="py-base-class">_BaseLoader</tt><tt class="py-op">,</tt> <tt class="py-base-class">_DataTypeMixin</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_DirectCommon-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="_DirectCommon-expanded"><a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar value: The message to send.</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">    @type value: number or str</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring">    @ivar subchannel: The subchannel of the message in the range 0-127.</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line">    <tt id="link-5" class="py-name" targets="Variable lacewing.moo.packetloaders.client.ClientMessage.subchannel=lacewing.moo.packetloaders.client.ClientMessage-class.html#subchannel,Variable lacewing.moo.packetloaders.client.PrivateMessage.subchannel=lacewing.moo.packetloaders.client.PrivateMessage-class.html#subchannel,Variable lacewing.moo.packetloaders.client.ToChannelMessage.subchannel=lacewing.moo.packetloaders.client.ToChannelMessage-class.html#subchannel,Variable lacewing.moo.packetloaders.server.FromChannelMessage.subchannel=lacewing.moo.packetloaders.server.FromChannelMessage-class.html#subchannel,Variable lacewing.packetloaders.channelmessage.ToChannelMessage.subchannel=lacewing.packetloaders.channelmessage.ToChannelMessage-class.html#subchannel,Variable lacewing.packetloaders.peermessage.SendPrivate.subchannel=lacewing.packetloaders.peermessage.SendPrivate-class.html#subchannel"><a title="lacewing.moo.packetloaders.client.ClientMessage.subchannel
lacewing.moo.packetloaders.client.PrivateMessage.subchannel
lacewing.moo.packetloaders.client.ToChannelMessage.subchannel
lacewing.moo.packetloaders.server.FromChannelMessage.subchannel
lacewing.packetloaders.channelmessage.ToChannelMessage.subchannel
lacewing.packetloaders.peermessage.SendPrivate.subchannel" class="py-name" href="#" onclick="return doclink('link-5', 'subchannel', 'link-5');">subchannel</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line">    <tt id="link-6" class="py-name" targets="Variable lacewing.moo.packetloaders.message.Message.value=lacewing.moo.packetloaders.message.Message-class.html#value,Variable lacewing.multidict.DictItem.value=lacewing.multidict.DictItem-class.html#value,Variable lacewing.packetloaders.channelmessage.ToChannelMessage.value=lacewing.packetloaders.channelmessage.ToChannelMessage-class.html#value,Variable lacewing.packetloaders.peermessage.SendPrivate.value=lacewing.packetloaders.peermessage.SendPrivate-class.html#value"><a title="lacewing.moo.packetloaders.message.Message.value
lacewing.multidict.DictItem.value
lacewing.packetloaders.channelmessage.ToChannelMessage.value
lacewing.packetloaders.peermessage.SendPrivate.value" class="py-name" href="#" onclick="return doclink('link-6', 'value', 'link-6');">value</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"> </tt>
<a name="_DirectCommon.read"></a><div id="_DirectCommon.read-def"><a name="L19"></a><tt class="py-lineno">19</tt> <a class="py-toggle" href="#" id="_DirectCommon.read-toggle" onclick="return toggle('_DirectCommon.read');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="lacewing.packetloaders.directmessage._DirectCommon-class.html#read">read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_DirectCommon.read-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="_DirectCommon.read-expanded"><a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="lacewing.moo.packetloaders.client.ClientMessage.subchannel
lacewing.moo.packetloaders.client.PrivateMessage.subchannel
lacewing.moo.packetloaders.client.ToChannelMessage.subchannel
lacewing.moo.packetloaders.server.FromChannelMessage.subchannel
lacewing.packetloaders.channelmessage.ToChannelMessage.subchannel
lacewing.packetloaders.peermessage.SendPrivate.subchannel" class="py-name" href="#" onclick="return doclink('link-7', 'subchannel', 'link-5');">subchannel</a></tt><tt class="py-op">,</tt> <tt class="py-op">=</tt> <tt class="py-name">unpack_from</tt><tt class="py-op">(</tt><tt class="py-string">'&lt;B'</tt><tt class="py-op">,</tt> <tt id="link-8" class="py-name" targets="Method lacewing.bytereader.ByteReader.data()=lacewing.bytereader.ByteReader-class.html#data"><a title="lacewing.bytereader.ByteReader.data" class="py-name" href="#" onclick="return doclink('link-8', 'data', 'link-8');">data</a></tt><tt class="py-op">)</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">readMessage</tt><tt class="py-op">(</tt><tt id="link-9" class="py-name"><a title="lacewing.bytereader.ByteReader.data" class="py-name" href="#" onclick="return doclink('link-9', 'data', 'link-8');">data</a></tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
</div><a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"> </tt>
<a name="_DirectCommon.generate"></a><div id="_DirectCommon.generate-def"><a name="L23"></a><tt class="py-lineno">23</tt> <a class="py-toggle" href="#" id="_DirectCommon.generate-toggle" onclick="return toggle('_DirectCommon.generate');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="lacewing.packetloaders.directmessage._DirectCommon-class.html#generate">generate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_DirectCommon.generate-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="_DirectCommon.generate-expanded"><a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line">        <tt id="link-10" class="py-name"><a title="lacewing.bytereader.ByteReader.data" class="py-name" href="#" onclick="return doclink('link-10', 'data', 'link-8');">data</a></tt> <tt class="py-op">=</tt> <tt class="py-name">pack</tt><tt class="py-op">(</tt><tt class="py-string">'&lt;B'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="lacewing.moo.packetloaders.client.ClientMessage.subchannel
lacewing.moo.packetloaders.client.PrivateMessage.subchannel
lacewing.moo.packetloaders.client.ToChannelMessage.subchannel
lacewing.moo.packetloaders.server.FromChannelMessage.subchannel
lacewing.packetloaders.channelmessage.ToChannelMessage.subchannel
lacewing.packetloaders.peermessage.SendPrivate.subchannel" class="py-name" href="#" onclick="return doclink('link-11', 'subchannel', 'link-5');">subchannel</a></tt><tt class="py-op">)</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-12" class="py-name"><a title="lacewing.bytereader.ByteReader.data" class="py-name" href="#" onclick="return doclink('link-12', 'data', 'link-8');">data</a></tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">generateMessage</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"> </tt>
<a name="ClientMessage"></a><div id="ClientMessage-def"><a name="L27"></a><tt class="py-lineno">27</tt> <a class="py-toggle" href="#" id="ClientMessage-toggle" onclick="return toggle('ClientMessage');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lacewing.packetloaders.directmessage.ClientMessage-class.html">ClientMessage</a><tt class="py-op">(</tt><tt class="py-base-class">_DirectCommon</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ClientMessage-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="ClientMessage-expanded"><a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"><tt class="py-docstring">    This is sent from the client as a direct message to the server.</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
</div><a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line"> </tt>
<a name="ServerMessage"></a><div id="ServerMessage-def"><a name="L32"></a><tt class="py-lineno">32</tt> <a class="py-toggle" href="#" id="ServerMessage-toggle" onclick="return toggle('ServerMessage');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="lacewing.packetloaders.directmessage.ServerMessage-class.html">ServerMessage</a><tt class="py-op">(</tt><tt class="py-base-class">_DirectCommon</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ServerMessage-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="ServerMessage-expanded"><a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line"><tt class="py-docstring">    This is sent from the server as a direct message to the client.</tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
</div><a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line"> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line"><tt class="py-name">__all__</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'ClientMessage'</tt><tt class="py-op">,</tt> <tt class="py-string">'ServerMessage'</tt><tt class="py-op">]</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lacewing-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://mathias.aquadasoft.com">Python Lacewing Library</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Sep 16 22:07:42 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
